Add release process#50
Draft
abarciauskas-bgse wants to merge 5 commits into
Draft
Conversation
|
abarciauskas-bgse
requested review from
betolink,
danielfromearth,
jhkennedy and
sharkinsspatial
and removed request for
sharkinsspatial
|
|
||
| ### Steps to create a release | ||
|
|
||
| 1. **Decide on a version number.** Use `vMAJOR.MINOR` (e.g., `v1.0`, `v1.1`, `v2.0`). Increment the major version for significant restructuring or scope changes; increment the minor version for new sections or substantial updates. |
Collaborator
There was a problem hiding this comment.
The initial description in the PR says v1.0.0, but this says only MAJOR.MINOR. I'd lean towards the latter, which is what's written in this contributing.qmd.
|
|
||
| ## Release Process | ||
|
|
||
| Releases mark citable snapshots of the report. Not every merged PR needs a release — cut one when there is a meaningful body of new or revised content. |
Collaborator
There was a problem hiding this comment.
"citable snapshots".... should we also make a CITATION.cff and connect with Zenodo (could be a separate issue/PR)?
Co-authored-by: Daniel Kaufman <114174502+danielfromearth@users.noreply.github.com>
Contributor
Author
|
Thanks for reviewing @danielfromearth ! I addressed the changes you suggested. |
Contributor
Author
|
converting this to draft since I am waiting to setup Zenodo (getting timeouts at the moment) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Following #47 we should make an initial release using the tag
v1.0.